Skip to main content

parameter

Parameter Model​

Defines a parameter used in tools, including metadata about its identity, purpose, and constraints.

id (integer, Read-only)​

Unique identifier of the parameter.

name (string) Required​

The name of the parameter.

  • Min length: 1

description (string) Required​

A description explaining the purpose or expected content of the parameter.

  • Min length: 1

type (string) Required​

The data type of the parameter.

  • Min length: 1

items (object, Nullable, Optional)​

Schema information for array or object parameters. For arrays, this must be an object with only a type key, for example { "type": "string" }. For objects, this contains the object properties schema.

required (boolean) Required​

Indicates whether this parameter must be provided for the tool to function.

Example​

{
  "id": 0,
  "name": "query",
  "description": "Search query",
  "type": "string",
  "items": null,
  "required": true
}